package Spring.handler.Servlet;

import Spring.handler.Entities.User;
import com.sun.org.apache.xpath.internal.SourceTree;
import com.sun.org.apache.xpath.internal.res.XPATHErrorResources_it;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;

/**
 * Created by BF100233 on 2016/8/16.
 */
//@SessionAttributes(value = {"user"},types = {String.class})
@RequestMapping("/SpringMvc")
@Controller
public class SpringMVCTest {

    private static final String SUCCESS = "success";
    private static final String INDEX = "/index.jsp";

    /**
     * 请求重定向
     * @return
     */
    @RequestMapping("testRedirect")
    public String testRedirect(){
        System.out.println("test Redirect");
        return "redirect:"+INDEX;
    }

    /**
     * 请求转发
     * @return
     */
    @RequestMapping("testForward")
    public String testForward(){
        System.out.println("test Forward");
        return "forward:"+INDEX;
    }

    @RequestMapping("testView")
    public String testView(){
        System.out.println(" test View ");
        return "helloView";
    }

    @RequestMapping("testViewAndViewResolver")
    public String testViewAndViewResolver(){
        System.out.println("test ViewAndViewResolver");
        return SUCCESS;
    }

    //=================================下面是8.23之前的========================================================

    /**☆☆☆☆☆常用
     * 1.由 @ModelAttribute 标记的方法，会在每个目标方法被调用之前被 SpringMvc 调用
     *
     * 2.@ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参，其 value 属性值有如下作用:
     *   1)SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象，若不存在则会直接传入到目标方法的入参中。
     *   2)SpringMVC 会一 value 为 key, POJO 类型的对象为 value ，存入到 request 中。
     * @param id
     * @param map
     */
    @ModelAttribute
    public void getUser(@RequestParam(value = "id", required = false) Integer id, Map<String, Object> map) {
        if (id != null) {
            //模拟从数据库中获取对象
            User user = new User(1, "Dog", "123456", "tom@dog.com", 18);
            System.out.println("user:" + user);
            map.put("user", user);
        }

    }

    /**
     * 运行流程：
     * 1.执行 @ModelAttribute 注释修饰的方法：从数据库中取出对象，把对象放入到 Map 中，键为 user
     * 2.SpringMVC 从 Map 中取出 User 对象，并把表单的请求参数赋给该 User 对象的对应属性
     * 3.SpringMVC 把上述对象传入目标方法的参数。
     *
     * 注意：在 @ModelAttribute 修饰的方法中 ，放入到 Map 时的键需要和目标方法放入参数类型的第一个字母小写的字符串一致。
     *
     * SpringMVC 确定目标方法 POJO 类型入参的过程
     * 1.确定一个 key:
     *   1）若目标方法的 pojo 类型的参数 没有使用 @ModelAttribute 作为修饰，则 key 为 POJO 类名第一个字母的小写
     *   2）若使用@ModelAttribute 来修饰，则 key 为 @ModelAttribute 注解的 value 属性值。
     *
     * 2.在 implicitModel 中查找 key 对应的对象，若存在，则作为入参传入
     *   1）若在 @ModelAttribute 标记的方法中在 Map 中保存过，且 key 和 1 确定的 key 一致，则会获取到。
     *
     * 3.若 implicitModel 中不存在 key 对应的对象， 则检查当前的 Handler 是否使用 @SessionAttributes 注释修饰，若使用了该注
     * 解，且 @SessionAttribute 注解的 value 属性值中包含了 key,则会从 HttpSession 中来获取 key 所对应的 value 值，若存在则
     * 直接传入到目标方法的入参中，若不存在则将抛出异常。
     * 4.若 Handler 没有标识 @SessionAttributes 注解，或 @SessionAttributes 注解的 value 值中不包含 key, 则会通过反射来创建
     * POJO类型的参数，传入为目标方法参数。
     * 5.SpringMVC 会把 key 和 POJO 类型的对象保存到　implicitModel　中，近而会保存到　request 中。
     *
     * 源代码分析的流程
     * 1.调用 @ModelAttribute 注解修饰的方法。 实际上把 @ModelAttribute 方法中 Map 种的数据放在了 implicitModel 中。
     * 2.解析请求处理器的目标参数，实际上该目标参数来自于 WebDataBinder 对象的 target 属性
     *   1）.创建 WebDataBinder 对象：
     *      ①.确定 objectName 属性：若传入的 attrName 属性值为"",则 objectName 为类名第一个字母小写。
     *      *注意：attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰，则 attrName 值即为 @ModelAttribute 的 value 属性值
     *      ②.确定 target 属性：
     *         >在 implicitModel 中查找 attrName 的属性值。若存在，ok
     *         >*若不存在：则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰，若使用了，则尝试从 Session 中获取 attrName 所对应的属性值。
     *         若 Session 中没有对应的属性值，则抛出了异常。
     *         >若 Handler 没有使用 @SessionAttributes 进行修饰，或 @SessionAttributes 中没有使用 value 值指定的 key 和 attrName 相匹配，则通过反射创建了POJO对象
     *
     *   2）SpringMVC 把请求表单的请求参数赋给了 WebDataBinder 的 target 对应的属性
     *
     *   3）*SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel 近而传到 request 域对象中。
     *
     *   4）把 WebDataBinder 的 target 作为参数传递给目标方法的入参。
     *
     * @param user
     * @return
     */
    @RequestMapping("testModelAttribute")
    public String testModelAttribute(User user) {
        System.out.println("修改：" + user);

        return SUCCESS;
    }

    /**
     * @param map
     * @return
     * @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外（实际上使用的是 value 属性值），
     * 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中 （实际上使用的是 types 属性值）。
     * <p>
     * 注意：该注解只能放在类的上面，而不能放在方法上面
     */
    @RequestMapping("testSessionAttributes")
    public String testSessionAttributes(Map<String, Object> map) {
        User user = new User("Tom", "123456", "tom@cat.com", 18);
        map.put("user", user);
        map.put("school", "testdemo");

        return SUCCESS;
    }

    /**
     * ☆☆☆☆☆常用
     * 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数
     *
     * @param map
     * @return
     */
    @RequestMapping("testMap")
    public String testMap(Map<String, Object> map) {
        System.out.println(map.getClass().getName());
        map.put("names", Arrays.asList("Tom", "Jerry", "Mike"));
        return SUCCESS;
    }

    //=================================下面是8.20之前的========================================================

    /**
     * 目标方法的返回值可以是 ModelAndView 类型
     * 其中可以包含视图和模型信息
     * <p>
     * SpringMVC 会把 ModelAndView 的 model 中数据放入到 request 域对象中。
     *
     * @return
     */
    @RequestMapping("testModelAndView")
    public ModelAndView testModelAndView() {
        String viewName = SUCCESS;
        ModelAndView modelAndView = new ModelAndView(viewName);

        //添加模型数据到 ModelAndView 中。
        modelAndView.addObject("time", new Date());

        return modelAndView;
    }


    /**
     * 可以使用 Servlet 原生的 API 作为目标方法的参数 具体指出以下类型
     * HttpServletRequest
     * HttpServletResponse
     * HttpSession
     * java.security.Principal
     * Locale
     * InputStream
     * OutputStream
     * Reader
     * Writer
     */
    @RequestMapping("testServletAPI")
    public void testServletAPI(HttpServletRequest request, HttpServletResponse response, Writer out) throws IOException {
        System.out.println("testServletAPI ," + request + "," + response);
        out.write("hello Servlet SPI");
//        return SUCCESS;
    }

    /**
     * ☆☆☆☆☆常用
     * SpringMvc 会按请求参数名和 POJO 属性名进行自动匹配
     * 自动为该对象填充属性值，支持级联属性。如：address.city、address.province
     *
     * @param user
     * @return
     */
    @RequestMapping("testPojo")
    public String testPojo(User user) {
        System.out.println("test Pojo User:" + user);
        return SUCCESS;
    }

    /**
     * ☆☆了解
     *
     * @param ssionID
     * @return
     * @CookieValue 映射一个 Cookie 值 ，属性同 @RequestParam
     */
    @RequestMapping("testCoolieValue")
    public String testCoolieValue(@CookieValue("JSESSIONID") String ssionID) {
        System.out.println("testCoolieValue ssionID:" + ssionID);
        return SUCCESS;
    }

    /**
     * ☆☆了解
     * 映射请求头信息
     * 用法同 @RequestParam
     *
     * @param encode
     * @return
     */
    @RequestMapping("testRequestHeader")
    public String testRequestHeader(@RequestHeader("Accept-Encoding") String encode) {
        System.out.println("Accept-Encoding" + encode);
        return SUCCESS;
    }

    /**
     * ☆☆☆☆☆常用
     *
     * @param name
     * @param age
     * @return
     * @RequsetParam 来映射请求参数
     * value 值即请求参数的参数名
     * required 该参数是否必须。 默认为 ture
     * defaultValue 请求参数默认值
     */
    @RequestMapping("testRequestParam")
    public String testRequestParam(@RequestParam("name") String name, @RequestParam(value = "age", required = false) Integer age) {
        System.out.println("testRequestParam Name:" + name + "，age:" + age);
        return SUCCESS;
    }
//=================================下面是8.19之前的========================================================

    /**
     * Rest 风格的 URL.
     * 以 CRUD 为例：
     * 新增：/order POST
     * 修改：/order/1 PUT    update?id=1
     * 获取：/order/1 GET    get?id=1
     * 删除：/order/1 DELETE    delete?id=1
     * 如何发送PUT请求和DELETE请求呢？
     * 1.需要配置 HiddenHttpMethodFilter
     * 2.需要发送 POST 请求
     * 3.需要在发送 POST 请求时，携带一个 name='_method' 的隐藏域，值为DELETE 或 PUT
     * <p>
     * 在 SpringMVC 的目标方法中如何得到id呢？
     * 使用 @PathVariable 注解
     *
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.PUT)
    public String testRestPUT(@PathVariable("id") Integer id) {
        System.out.println("test Rest Put:" + id);
        return SUCCESS;
    }

    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.DELETE)
    public String testRestDelete(@PathVariable("id") Integer id) {
        System.out.println("test Rest Delete:" + id);
        return SUCCESS;
    }

    @RequestMapping(value = "/testRest", method = RequestMethod.POST)
    public String testRest() {
        System.out.println("test Rest Post");
        return SUCCESS;
    }

    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.GET)
    public String testRest(@PathVariable("id") Integer id) {
        System.out.println("test Rest Get:" + id);
        return SUCCESS;
    }

    /**
     * @param num
     * @return
     * @PathVariable 可以来映射 URL 中的占位符到目标方法的参数中
     */
    @RequestMapping("/testPathVariable/{num}")
    public String testPathVariable(@PathVariable("num") Integer num) {
        System.out.println("test PathVariable:" + num);
        return SUCCESS;
    }

    /**
     * 了解：
     * ？：一个字符
     * * ：同一层级任意长度字符
     * ** ：两个层级任意长度字符
     *
     * @return
     */
    @RequestMapping("/testAntPath/*/ant")
    public String testAntPath() {
        System.out.println("test AntPath");
        return SUCCESS;
    }

    /**
     * 了解：使用 params 和 headers 来更加精确的映射请求。 params 和 headers 支持简单的表达式
     *
     * @return
     */
    @RequestMapping(value = "testParamsAndHeaders", params = {"username", "age!=10"}, headers = {"Accept-Encoding=gzip, deflate"})
    public String testParamsAndHeaders() {
        System.out.println("test ParamsAndHeaders");
        return SUCCESS;
    }

    /**
     * 常用：使用 method 属性来指定请求方式
     *
     * @return
     */
    @RequestMapping(value = "/testMethod", method = RequestMethod.POST)
    public String testMethod() {
        System.out.println("test Method");
        return SUCCESS;
    }

    /**
     * 1.@RequestMapping 除了修饰方法，还可以修饰类
     * 2.1>类定义处：提供初步的请求映射信息，相对于 WEB 应用的根目录
     * 2.2>方法处：提供进一步的细分映射信息，相对于类定义处的URL，若类定义处未标注 @RequestMapping,则方法处标记的 URL 相对于 WEB 应用的根目录
     *
     * @return
     */
    @RequestMapping("/TestRequestMapping")
    public String TestRequestMapping() {
        System.out.println("testRequestMapping ");
        return SUCCESS;
    }

}
